/* NOTICE
    OpenJaWS - Open Java Weather Station
    
    Copyright (C) 2008 Grant Gardner <grant@lastweekend.com.au>
    
    OpenJaWS is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
    
NOTICE */
package au.com.lastweekend.openjaws.api;

import java.util.Date;

import au.com.lastweekend.openjaws.units.Unit;
import au.com.lastweekend.openjaws.util.StringUtil;

/**
 * Structure wrapping a unit value with time.
 * 
 * @author ggardner
 * 
 */
public class RecordedValue implements StringUtil.DeepFormatter {
    
    private Date time;
    private UnitValue unitValue;

    public static final RecordedValue NULL = new RecordedValue(null,UnitValue.NULL);
    
    public RecordedValue(Date time, double value, Unit unit) {

        this(time, new UnitValue(value, unit));
    }

    public RecordedValue(Date time, UnitValue unitValue) {
        this.time = time;
        this.unitValue = unitValue;
    }

    public Date getTime() {

        return time;
    }

    public UnitValue getUnitValue() {

        return unitValue;
    }

    public String toString() {

        //We don't know the subclass of Unit value so we can't guess a format
        return String.format("%s @ %tc", unitValue, time);
    }

    public String format(String formatSpec) {

        return StringUtil.deepFormat(formatSpec, this);

    }

    public Object[] formatArgs() {

        return new Object[]{unitValue, time};
    }


}